<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="IPublisher,gugga.logging.IPublisher,publish,setFilter,getFilter,setFormatter,getFormatter,setLevel,getLevel,isLoggable" name="keywords">
<title>gugga.logging.IPublisher</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IPublisher - API Documentation';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?gugga/logging/IPublisher.html&amp;gugga/logging/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;IPublisher</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IPublisher"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">gugga.logging</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IPublisher</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implementors</td><td><a href="publishers/BasePublisher.html">BasePublisher</a></td>
</tr>
</table>
<p></p>
 A publisher takes log messages from a Logger and exports them. 
 It might for example, write them to the Flash IDE output window or write them to a file, 
 or send them to a network logging service, or forward them to an OS log, or whatever.
  <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getFilter()">getFilter</a>():<a href="../logging/IFilter.html">IFilter</a>
</div>
<div class="summaryTableDescription">
  Get the current filter for this Publisher.</div>
</td><td class="summaryTableOwnerCol">IPublisher</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getFormatter()">getFormatter</a>():<a href="../logging/IFormatter.html">IFormatter</a>
</div>
<div class="summaryTableDescription">
  Gets the formatter currently associated with this publisher
    </div>
</td><td class="summaryTableOwnerCol">IPublisher</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getLevel()">getLevel</a>():<a href="../logging/Level.html">Level</a>
</div>
<div class="summaryTableDescription">
  Get the log level specifying which messages will be logged by this Publisher.</div>
</td><td class="summaryTableOwnerCol">IPublisher</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#isLoggable()">isLoggable</a>(logRecord:<a href="LogRecord.html">LogRecord</a>):Boolean</div>
<div class="summaryTableDescription">
  Check if this Publisher would actually log a given LogRecord.</div>
</td><td class="summaryTableOwnerCol">IPublisher</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#publish()">publish</a>(logRecord:<a href="LogRecord.html">LogRecord</a>):void</div>
<div class="summaryTableDescription">
  Publish a LogRecord.</div>
</td><td class="summaryTableOwnerCol">IPublisher</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setFilter()">setFilter</a>(filter:<a href="IFilter.html">IFilter</a>):void</div>
<div class="summaryTableDescription">
  Set a filter to control output on this Publisher.</div>
</td><td class="summaryTableOwnerCol">IPublisher</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setFormatter()">setFormatter</a>(formatter:<a href="IFormatter.html">IFormatter</a>):void</div>
<div class="summaryTableDescription">
  Set a formatter for this publisher
    </div>
</td><td class="summaryTableOwnerCol">IPublisher</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setLevel()">setLevel</a>(level:<a href="Level.html">Level</a>):void</div>
<div class="summaryTableDescription">
  Set the log level specifying which message levels will be logged by this Publisher.</div>
</td><td class="summaryTableOwnerCol">IPublisher</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="getFilter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getFilter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function getFilter():<a href="../logging/IFilter.html">IFilter</a></code><p>
  Get the current filter for this Publisher. 
    </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../logging/IFilter.html">IFilter</a></code> &mdash; 
                        A filter object or undefined.
  
                        
                     </td>
</tr>
</table>
</div>
<a name="getFormatter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getFormatter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getFormatter():<a href="../logging/IFormatter.html">IFormatter</a></code><p>
  Gets the formatter currently associated with this publisher
    </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../logging/IFormatter.html">IFormatter</a></code> &mdash; 
                        the formatter object
  
                        
                     </td>
</tr>
</table>
</div>
<a name="getLevel()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getLevel</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getLevel():<a href="../logging/Level.html">Level</a></code><p>
  Get the log level specifying which messages will be logged by this Publisher. 
  Message levels lower than this level will be discarded.
    </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../logging/Level.html">Level</a></code> &mdash; 
                        the level of messages being logged. 
  
                        
                     </td>
</tr>
</table>
</div>
<a name="isLoggable()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">isLoggable</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function isLoggable(logRecord:<a href="LogRecord.html">LogRecord</a>):Boolean</code><p>
  Check if this Publisher would actually log a given LogRecord. 
  This method checks if the LogRecord has an appropriate Level and whether it satisfies any Filter. 
  It also may make other Publisher specific checks that might prevent a publisher from logging the LogRecord. 
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">logRecord</span>:<a href="LogRecord.html">LogRecord</a></code> &mdash; LogRecord to be checked
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; true if loggable, otherwise false
  </td>
</tr>
</table>
</div>
<a name="publish()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">publish</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function publish(logRecord:<a href="LogRecord.html">LogRecord</a>):void</code><p>
  Publish a LogRecord. 
  The logging request was made initially to a Logger object, which initialized the LogRecord and forwarded it here. 
  The Handler is responsible for formatting the message.
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">logRecord</span>:<a href="LogRecord.html">LogRecord</a></code> &mdash; The log record to be published
  </td>
</tr>
</table>
</div>
<a name="setFilter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setFilter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setFilter(filter:<a href="IFilter.html">IFilter</a>):void</code><p>
  Set a filter to control output on this Publisher. 
  For each call of publish the Publisher will call this Filter (if it is non-null) to check if the LogRecord should be published or discarded.  
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">filter</span>:<a href="IFilter.html">IFilter</a></code> &mdash; filter object
  </td>
</tr>
</table>
</div>
<a name="setFormatter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setFormatter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setFormatter(formatter:<a href="IFormatter.html">IFormatter</a>):void</code><p>
  Set a formatter for this publisher
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">formatter</span>:<a href="IFormatter.html">IFormatter</a></code> &mdash; suitable formatter object
  </td>
</tr>
</table>
</div>
<a name="setLevel()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setLevel</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setLevel(level:<a href="Level.html">Level</a>):void</code><p>
  Set the log level specifying which message levels will be logged by this Publisher. 
  Message levels lower than this value will be discarded.
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">level</span>:<a href="Level.html">Level</a></code> &mdash; the new value for the log level 
  </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
